pp108 : Progressbar (Object)

Progressbar (Object)


The Progressbar control is used to display the progress and status of an activity. You can add only one Progressbar control to an XForm. After adding it to an XForm, you can define the position in which it is to be displayed in the form. To do so, right-click and select Position > Vertical, Horizontal, or Free.

This control is derived from the AJAX Toolkit library - Progressbar. For details about the control's behavior and functionality, see Progressbar.

Properties, Events, and Methods of the Control

The properties, events, and methods associated with the Progressbar control define its behavior. You can set them either through the control's property sheet or programmatically using the APIs. For details, see Progressbar.

The following XForms-related properties and methods are available for the control:

Table 1. List of Properties

Design-time property

Runtime property

Description

ID

Sets the string that identifies the control on an XForm. If not specified, a unique ID is automatically generated.

No. of Divisions

Sets the number of divisions that are used to display progress at run time.

Table 2. List of Methods

Method

Description

addListener(sEventName, fpFunction)

This method registers a function to an event, such that the function gets called when the event is fired on the control.

disable()

This method disables the control on which it is invoked.

enable()

This method enables the control on which it is invoked.

hide()

This method hides controls and all associated child controls.

isEnabled()

This method retrieves the value that denotes whether the control is enabled or not.

removeListener(sEventName, fpFunction)

This method unregisters a function from an event, such that the function stops getting called when the event is fired on the control.

show()

This method makes the control and its child controls visible.